home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / Kubuntu 8.10 / kubuntu-8.10-desktop-i386.iso / casper / filesystem.squashfs / usr / share / hplip / scan / sane.py < prev   
Text File  |  2008-10-13  |  22KB  |  604 lines
  1. # -*- coding: utf-8 -*-
  2. #
  3. # (c) Copyright 2003-2007 Hewlett-Packard Development Company, L.P.
  4. #
  5. # This program is free software; you can redistribute it and/or modify
  6. # it under the terms of the GNU General Public License as published by
  7. # the Free Software Foundation; either version 2 of the License, or
  8. # (at your option) any later version.
  9. #
  10. # This program is distributed in the hope that it will be useful,
  11. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13. # GNU General Public License for more details.
  14. #
  15. # You should have received a copy of the GNU General Public License
  16. # along with this program; if not, write to the Free Software
  17. # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  18. #
  19. # Based on:
  20. # "sane.py", part of the Python Imaging Library (PIL)
  21. # http://www.pythonware.com/products/pil/
  22. # Python wrapper on top of the _sane module, which is in turn a very
  23. # thin wrapper on top of the SANE library.  For a complete understanding
  24. # of SANE, consult the documentation at the SANE home page:
  25. # http://www.mostang.com/sane/ .#
  26. #
  27. # Modified to work without PIL by Don Welch
  28. # 
  29. # (C) Copyright 2003 A.M. Kuchling.  All Rights Reserved
  30. # (C) Copyright 2004 A.M. Kuchling, Ralph Heinkel  All Rights Reserved
  31. #
  32. # Permission to use, copy, modify, and distribute this software and its
  33. # documentation for any purpose and without fee is hereby granted,
  34. # provided that the above copyright notice appear in all copies and that
  35. # both that copyright notice and this permission notice appear in
  36. # supporting documentation, and that the name of A.M. Kuchling and
  37. # Ralph Heinkel not be used in advertising or publicity pertaining to 
  38. # distribution of the software without specific, written prior permission.
  39. # 
  40. # A.M. KUCHLING, R.H. HEINKEL DISCLAIM ALL WARRANTIES WITH REGARD TO THIS 
  41. # SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS,
  42. # IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  43. # CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
  44. # USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
  45. # OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  46. # PERFORMANCE OF THIS SOFTWARE.
  47. # Python wrapper on top of the scanext module, which is in turn a very
  48. # thin wrapper on top of the SANE library.  For a complete understanding
  49. # of SANE, consult the documentation at the SANE home page:
  50. # http://www.mostang.com/sane/ .
  51. #
  52. # Original authors: Andrew Kuchling, Ralph Heinkel
  53. # Modified by: Don Welch
  54. #
  55.  
  56. # Std Lib
  57. import scanext
  58. import threading
  59. import time
  60. import os
  61. import Queue
  62.  
  63. # Local
  64. from base.g import *
  65. from base import utils
  66.  
  67. EVENT_SCAN_CANCELED = 1
  68.  
  69. TYPE_STR = { scanext.TYPE_BOOL:   "TYPE_BOOL",   scanext.TYPE_INT:    "TYPE_INT",
  70.              scanext.TYPE_FIXED:  "TYPE_FIXED",  scanext.TYPE_STRING: "TYPE_STRING",
  71.              scanext.TYPE_BUTTON: "TYPE_BUTTON", scanext.TYPE_GROUP:  "TYPE_GROUP" }
  72.  
  73. UNIT_STR = { scanext.UNIT_NONE:        "UNIT_NONE",
  74.              scanext.UNIT_PIXEL:       "UNIT_PIXEL",
  75.              scanext.UNIT_BIT:         "UNIT_BIT",
  76.              scanext.UNIT_MM:          "UNIT_MM",
  77.              scanext.UNIT_DPI:         "UNIT_DPI",
  78.              scanext.UNIT_PERCENT:     "UNIT_PERCENT",
  79.              scanext.UNIT_MICROSECOND: "UNIT_MICROSECOND" }
  80.  
  81.  
  82. class Option:
  83.     """Class representing a SANE option.
  84.     Attributes:
  85.     index -- number from 0 to n, giving the option number
  86.     name -- a string uniquely identifying the option
  87.     title -- single-line string containing a title for the option
  88.     desc -- a long string describing the option; useful as a help message
  89.     type -- type of this option.  Possible values: TYPE_BOOL,
  90.             TYPE_INT, TYPE_STRING, and so forth.
  91.     unit -- units of this option.  Possible values: UNIT_NONE,
  92.             UNIT_PIXEL, etc.
  93.     size -- size of the value in bytes
  94.     cap -- capabilities available; CAP_EMULATED, CAP_SOFT_SELECT, etc.
  95.     constraint -- constraint on values.  Possible values:
  96.         None : No constraint
  97.         (min,max,step)  Integer values, from min to max, stepping by
  98.         list of integers or strings: only the listed values are allowed
  99.     """
  100.  
  101.     def __init__(self, args, cur_device):
  102.         import string
  103.         self.cur_device = cur_device
  104.         
  105.         self.index, self.name, self.title, self.desc, self.type, \
  106.             self.unit, self.size, self.cap, self.constraint = args
  107.         
  108.         if type(self.name) != type(''): 
  109.             self.name = str(self.name)
  110.             
  111.     def isActive(self):
  112.         return scanext.isOptionActive(self.cap)
  113.         
  114.     def isSettable(self):
  115.         return scanext.isOptionSettable(self.cap)
  116.         
  117.     def __repr__(self):
  118.         if self.isSettable():
  119.             settable = 'yes'
  120.         else:
  121.             settable = 'no'
  122.         
  123.         if self.isActive():
  124.             active = 'yes'
  125.             curValue = self.cur_device.getOption(self.name)
  126.         else:
  127.             active = 'no'
  128.             curValue = '<not available, inactive option>'
  129.             
  130.         
  131.         return """\nName:      %s
  132. Cur value: %s
  133. Index:     %d
  134. Title:     %s
  135. Desc:      %s
  136. Type:      %s
  137. Unit:      %s
  138. Constr:    %s
  139. isActive:    %s
  140. isSettable:  %s\n""" % (self.name, curValue,
  141.                       self.index, self.title, self.desc,
  142.                       TYPE_STR[self.type], UNIT_STR[self.unit],
  143.                       self.constraint, active, settable)
  144.         return s
  145.         
  146.     def limitAndSet(self, value):
  147.         if value is not None and self.constraint is not None:
  148.             if type(self.constraint) == type(()):
  149.                 if value < self.constraint[0]:
  150.                     value = self.constraint[0]
  151.                     log.warn("Invalid value for %s (%s < min value of %d). Using %d." % 
  152.                         (self.name, self.name, value, value))
  153.                 
  154.                 elif value > self.constraint[1]:
  155.                     value = self.constraint[1]
  156.                     log.warn("Invalid value for %s (%s > max value of %d). Using %d." % 
  157.                         (self.name, self.name, value, value))
  158.                     
  159.                 self.cur_device.setOption(self.name, value)
  160.             
  161.             elif type(self.constraint) == type([]):
  162.                 if value not in self.constraint:
  163.                     v = self.constraint[0]
  164.                     min_dist = sys.maxint
  165.                     for x in self.constraint: 
  166.                         if abs(value-x) < min_dist:
  167.                             min_dist = abs(value-x)
  168.                             v = x
  169.                             
  170.                     log.warn("Invalid value for %s (%s not in constraint list: %s). Using %d." % 
  171.                         (self.name, self.name, value, ', '.join(self.constraint), v))
  172.                         
  173.                     self.cur_device.setOption(self.name, v)
  174.         
  175.         else:
  176.             value = self.cur_device.getOption(self.name)
  177.             
  178.         return value
  179.  
  180.  
  181. ##class _SaneIterator:
  182. ##    """ intended for ADF scans.
  183. ##    """
  184. ##
  185. ##    def __init__(self, cur_device):
  186. ##        self.cur_device = cur_device
  187. ##
  188. ##    def __iter__(self):
  189. ##        return self
  190. ##
  191. ##    def __del__(self):
  192. ##        self.cur_device.cancelScan()
  193. ##
  194. ##    def next(self):
  195. ##        try:
  196. ##            self.cur_device.startScan()
  197. ##        except error, v:
  198. ##            if v == 'Document feeder out of documents':
  199. ##                raise StopIteration
  200. ##            else:
  201. ##                raise
  202. ##        return self.cur_device.performScan(1)
  203.         
  204.  
  205.  
  206.  
  207. class ScanDevice:
  208.     """Class representing a SANE device.
  209.     Methods:
  210.     startScan()    -- initiate a scan, using the current settings
  211.     cancelScan()   -- cancel an in-progress scanning operation
  212.  
  213.     Also available, but rather low-level:
  214.     getParameters() -- get the current parameter settings of the device
  215.     getOptions()    -- return a list of tuples describing all the options.
  216.  
  217.     Attributes:
  218.     optlist -- list of option names
  219.  
  220.     You can also access an option name to retrieve its value, and to
  221.     set it.  For example, if one option has a .name attribute of
  222.     imagemode, and scanner is a ScanDevice object, you can do:
  223.          print scanner.imagemode
  224.          scanner.imagemode = 'Full frame'
  225.          scanner.['imagemode'] returns the corresponding Option object.
  226.     """
  227.     
  228.     def __init__(self, dev):
  229.         self.scan_thread = None
  230.         self.dev = scanext.openDevice(dev)
  231.         self.options = {}
  232.         self.__load_options_dict()
  233.  
  234.     def __load_options_dict(self):
  235.         opts = self.options
  236.         opt_list = self.dev.getOptions()
  237.         
  238.         for t in opt_list:
  239.             o = Option(t, self)
  240.             
  241.             if o.type != scanext.TYPE_GROUP:
  242.                 opts[o.name] = o
  243.  
  244.     def setOption(self, key, value):
  245.         opts = self.options
  246.         
  247.         if key not in opts:
  248.             opts[key] = value
  249.             return
  250.         
  251.         opt = opts[key]
  252.         
  253.         if opt.type == scanext.TYPE_GROUP:
  254.             raise AttributeError, "Groups can't be set: %s" % key
  255.         
  256.         if not scanext.isOptionActive(opt.cap):
  257.             raise AttributeError, 'Inactive option: %s' % key
  258.         
  259.         if not scanext.isOptionSettable(opt.cap):
  260.             raise AttributeError, "Option can't be set by software: %s" % key
  261.         
  262.         if type(value) == int and opt.type == scanext.TYPE_FIXED:
  263.             # avoid annoying errors of backend if int is given instead float:
  264.             value = float(value)
  265.         
  266.         self.last_opt = self.dev.setOption(opt.index, value)
  267.         
  268.         # do binary AND to find if we have to reload options:
  269.         if self.last_opt & scanext.INFO_RELOAD_OPTIONS:
  270.             self.__load_options_dict()
  271.  
  272.     def getOption(self, key):
  273.         opts = self.options
  274.         
  275.         if key == 'optlist':
  276.             return opts.keys()
  277.         
  278.         if key == 'area':
  279.             return (opts["tl-x"], opts["tl-y"]), (opts["br-x"], opts["br-y"])
  280.         
  281.         if key not in opts:
  282.             raise AttributeError, 'No such attribute: %s' % key
  283.         
  284.         opt = opts[key]
  285.         
  286.         if opt.type == scanext.TYPE_BUTTON:
  287.             raise AttributeError, "Buttons don't have values: %s" % key
  288.         
  289.         if opt.type == scanext.TYPE_GROUP:
  290.             raise AttributeError, "Groups don't have values: %s " % key
  291.         
  292.         if not scanext.isOptionActive(opt.cap):
  293.             raise AttributeError, 'Inactive option: %s' % key
  294.         
  295.         return self.dev.getOption(opt.index)
  296.  
  297.     def getOptionObj(self, key):
  298.         opts = self.options
  299.         if key in opts:
  300.             return opts[key]
  301.         
  302.  
  303.     def getParameters(self):
  304.         """Return a 6-tuple holding all the current device settings:
  305.            (format, format_name, last_frame, (pixels_per_line, lines), depth, bytes_per_line)
  306.         
  307.             - format is the SANE frame type
  308.             - format is one of 'grey', 'color' (RGB), 'red', 'green', 'blue'.
  309.             - last_frame [bool] indicates if this is the last frame of a multi frame image
  310.             - (pixels_per_line, lines) specifies the size of the scanned image (x,y)
  311.             - lines denotes the number of scanlines per frame
  312.             - depth gives number of pixels per sample
  313.         """
  314.         return self.dev.getParameters()
  315.  
  316.     def getOptions(self):
  317.         "Return a list of tuples describing all the available options"
  318.         return self.dev.getOptions()
  319.         
  320.     def startScan(self, byte_format='BGRA', update_queue=None, event_queue=None):
  321.         """
  322.             Perform a scan with the current device.
  323.             Calls sane_start().
  324.         """
  325.         if not self.isScanActive():
  326.             status = self.dev.startScan()
  327.             self.format, self.format_name, self.last_frame, self.pixels_per_line, \
  328.             self.lines, self.depth, self.bytes_per_line = self.dev.getParameters()
  329.             
  330.             self.scan_thread = ScanThread(self.dev, byte_format, update_queue, event_queue)
  331.             self.scan_thread.scan_active = True
  332.             self.scan_thread.start()
  333.             return True, self.lines * self.bytes_per_line, status
  334.         else:
  335.             # Already active
  336.             return False, 0, scanext.SANE_STATUS_DEVICE_BUSY
  337.             
  338.     def cancelScan(self):
  339.         "Cancel an in-progress scanning operation."
  340.         return self.dev.cancelScan()
  341.  
  342.     def getScan(self):
  343.         "Get the output buffer and info about a completed scan."
  344.         if not self.isScanActive():
  345.             s = self.scan_thread
  346.             
  347.             return s.buffer, s.format, s.format_name, s.pixels_per_line, \
  348.                 s.lines, s.depth, s.bytes_per_line, s.pad_bytes, s.total_read
  349.                 
  350.     def freeScan(self):
  351.         "Cleanup the scan file after a completed scan."
  352.         if not self.isScanActive():
  353.             s = self.scan_thread
  354.             
  355.             try:
  356.                 s.buffer.close()
  357.                 os.remove(s.buffer_path)
  358.             except (IOError, AttributeError):
  359.                 pass
  360.         
  361.     def isScanActive(self):
  362.         if self.scan_thread is not None:
  363.             return self.scan_thread.isAlive() and self.scan_thread.scan_active
  364.         else:
  365.             return False
  366.             
  367.     def waitForScanDone(self):
  368.         if self.scan_thread is not None and \
  369.             self.scan_thread.isAlive() and \
  370.             self.scan_thread.scan_active:
  371.  
  372.             try:
  373.                 self.scan_thread.join()
  374.             except KeyboardInterrupt:
  375.                 pass
  376.                 
  377.     def waitForScanActive(self):
  378.         time.sleep(0.5)
  379.         if self.scan_thread is not None:
  380.             while True:
  381.                 #print self.scan_thread.isAlive()
  382.                 #print self.scan_thread.scan_active
  383.                 if self.scan_thread.isAlive() and \
  384.                     self.scan_thread.scan_active:
  385.                     return
  386.                 
  387.                 time.sleep(0.5)
  388.                 #print "Waiting..."
  389.         
  390. ##    def scanMulti(self):
  391. ##        return _SaneIterator(self)
  392.         
  393.     def closeScan(self):
  394.         "Close the SANE device after a scan."
  395.         self.dev.closeScan()
  396.  
  397.         
  398. class ScanThread(threading.Thread):
  399.     def __init__(self, device, byte_format='BGRA', update_queue=None, event_queue=None):
  400.         threading.Thread.__init__(self)
  401.         self.scan_active = True
  402.         self.dev = device
  403.         self.update_queue = update_queue
  404.         self.event_queue = event_queue
  405.         self.buffer_fd, self.buffer_path = utils.make_temp_file(prefix='hpscan')
  406.         self.buffer = os.fdopen(self.buffer_fd, "w+b")
  407.         self.format = -1
  408.         self.format_name = ''
  409.         self.last_frame = -1
  410.         self.pixels_per_line = -1
  411.         self.lines = -1
  412.         self.depth = -1
  413.         self.bytes_per_line = -1
  414.         self.pad_bytes = -1
  415.         self.total_read = 0
  416.         self.byte_format = byte_format
  417.         
  418.         
  419.     def updateQueue(self, status, bytes_read):
  420.         if self.update_queue is not None:
  421.             try:
  422.                 status = int(status)
  423.             except (ValueError, TypeError):
  424.                 status = -1 #scanext.SANE_STATUS_GOOD
  425.                 
  426.             self.update_queue.put((status, bytes_read))
  427.             time.sleep(0)
  428.  
  429.     def run(self):
  430.         #self.scan_active = True
  431.         self.format, self.format_name, self.last_frame, self.pixels_per_line, \
  432.             self.lines, self.depth, self.bytes_per_line = self.dev.getParameters()
  433.             
  434.         log.debug("format=%d" % self.format)
  435.         log.debug("format_name=%s" % self.format_name)
  436.         log.debug("last_frame=%d" % self.last_frame)
  437.         log.debug("ppl=%d" % self.pixels_per_line)
  438.         log.debug("lines=%d" % self.lines)
  439.         log.debug("depth=%d" % self.depth)
  440.         log.debug("bpl=%d" % self.bytes_per_line)
  441.         log.debug("byte_format=%s" % self.byte_format)
  442.             
  443.         w = self.buffer.write
  444.         
  445.         if self.format == scanext.FRAME_RGB: # "Color"
  446.             if self.depth == 8: # 8 bpp (32bit)
  447.                 self.pad_bytes = self.bytes_per_line - 3 * self.pixels_per_line
  448.                 
  449.                 log.debug("pad_bytes=%d" % self.pad_bytes)
  450.                 
  451.                 dir = -1
  452.                 if self.byte_format == 'RGBA':
  453.                     dir = 1
  454.                 
  455.                 try:
  456.                     st, t = self.dev.readScan(self.bytes_per_line)
  457.                 except scanext.error, st:
  458.                     self.updateQueue(st, 0)
  459.                 
  460.                 #print st
  461.                 while st == scanext.SANE_STATUS_GOOD:
  462.                     
  463.                     if t:
  464.                         index = 0
  465.                         while index < len(t) - self.pad_bytes:
  466.                             w(t[index:index+3:dir])
  467.                             w('\xff')
  468.                             index += 3
  469.             
  470.                         self.total_read += len(t)
  471.                         self.updateQueue(st, self.total_read)
  472.                         log.debug("Read %d bytes" % self.total_read)
  473.                     
  474.                     else:
  475.                         time.sleep(0.1)
  476.                     
  477.                     try:
  478.                         st, t = self.dev.readScan(self.bytes_per_line)
  479.                     except scanext.error, st:
  480.                         self.updateQueue(st, self.total_read)
  481.                         break
  482.                     
  483.                     if self.checkCancel():
  484.                         break
  485.         
  486.         elif self.format == scanext.FRAME_GRAY: 
  487.         
  488.             if self.depth == 1: # 1 bpp lineart
  489.                 self.pad_bytes = self.bytes_per_line - (self.pixels_per_line + 7) // 8;
  490.                 
  491.                 log.debug("pad_bytes=%d" % self.pad_bytes)
  492.                 
  493.                 try:
  494.                     st, t = self.dev.readScan(self.bytes_per_line)
  495.                 except scanext.error, st:
  496.                     self.updateQueue(st, 0)
  497.                
  498.                 while st == scanext.SANE_STATUS_GOOD:
  499.                     
  500.                     if t:
  501.                         index = 0
  502.                         while index < len(t) - self.pad_bytes:
  503.                             k = 0x80
  504.                             j = ord(t[index])
  505.                             
  506.                             for b in range(8):
  507.                                 if k & j:
  508.                                     w("\x00\x00\x00\xff")
  509.                                 else:
  510.                                     w("\xff\xff\xff\xff")
  511.                                 
  512.                                 k = k >> 1
  513.                             
  514.                             index += 1
  515.                     
  516.                         self.total_read += len(t)
  517.                         self.updateQueue(st, self.total_read)
  518.                         log.debug("Read %d bytes" % self.total_read)
  519.                     else:
  520.                         time.sleep(0.1)
  521.                         
  522.                     try:
  523.                         st, t = self.dev.readScan(self.bytes_per_line)
  524.                     except scanext.error, st:
  525.                         self.updateQueue(st, self.total_read)
  526.                         break
  527.                 
  528.                     if self.checkCancel():
  529.                         break
  530.                     
  531.             elif self.depth == 8: # 8 bpp grayscale
  532.                 self.pad_bytes = self.bytes_per_line - self.pixels_per_line
  533.                 
  534.                 log.debug("pad_bytes=%d" % self.pad_bytes)
  535.                 
  536.                 try:
  537.                     st, t = self.dev.readScan(self.bytes_per_line)
  538.                 except scanext.error, st:
  539.                     self.updateQueue(st, 0)
  540.                 
  541.                 while st == scanext.SANE_STATUS_GOOD:
  542.                     
  543.                     if t:
  544.                         index = 0
  545.                         while index < len(t) - self.pad_bytes:
  546.                             j = t[index]
  547.                             w(j)
  548.                             w(j)
  549.                             w(j)
  550.                             w("\xff")
  551.                             
  552.                             index += 1
  553.                     
  554.                         self.total_read += len(t)
  555.                         self.updateQueue(st, self.total_read)
  556.                         log.debug("Read %d bytes" % self.total_read)
  557.                     else:
  558.                         time.sleep(0.1)
  559.                         
  560.                     try:
  561.                         st, t = self.dev.readScan(self.bytes_per_line)
  562.                     except scanext.error, st:
  563.                         self.updateQueue(st, self.total_read)
  564.                         break
  565.                     
  566.                     if self.checkCancel():
  567.                         break
  568.                     
  569.         #self.dev.cancelScan()
  570.         self.buffer.seek(0)
  571.         self.scan_active = False
  572.         log.debug("Scan thread exiting...")
  573.         
  574.     def checkCancel(self):
  575.         canceled = False
  576.         while self.event_queue.qsize():
  577.             try:
  578.                 event = self.event_queue.get(0)
  579.                 if event == EVENT_SCAN_CANCELED:
  580.                     canceled = True
  581.                     log.debug("Cancel pressed!")
  582.                     self.dev.cancelScan()
  583.             
  584.             except Queue.Empty:
  585.                 break
  586.  
  587.         return canceled
  588.         
  589.  
  590. def init():
  591.     return scanext.init()
  592.     
  593. def deInit():
  594.     return scanext.deInit()
  595.     
  596. def openDevice(dev):
  597.     "Open a device for scanning"
  598.     return ScanDevice(dev)
  599.     
  600. def getDevices(local_only=0):
  601.     return scanext.getDevices(local_only)
  602.     
  603.     
  604.